home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1998 November / Freeware November 1998.img / dist / fw_cvs.idb / usr / freeware / info / cvs.info-5.z / cvs.info-5 (.txt)
GNU Info File  |  1998-10-27  |  51KB  |  972 lines
  1. This is Info file cvs.info, produced by Makeinfo version 1.67 from the
  2. input file ../../work/ccvs/doc/cvs.texinfo.
  3. START-INFO-DIR-ENTRY
  4. * CVS: (cvs).          Concurrent Versions System
  5. END-INFO-DIR-ENTRY
  6.    Copyright (C) 1992, 1993 Signum Support AB Copyright (C) 1993, 1994
  7. Free Software Foundation, Inc.
  8.    Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies.
  11.    Permission is granted to copy and distribute modified versions of
  12. this manual under the conditions for verbatim copying, provided also
  13. that the entire resulting derived work is distributed under the terms
  14. of a permission notice identical to this one.
  15.    Permission is granted to copy and distribute translations of this
  16. manual into another language, under the above conditions for modified
  17. versions, except that this permission notice may be stated in a
  18. translation approved by the Free Software Foundation.
  19. File: cvs.info,  Node: Global options,  Next: Common options,  Prev: ~/.cvsrc,  Up: CVS commands
  20. Global options
  21. ==============
  22.    The available `cvs_options' (that are given to the left of
  23. `cvs_command') are:
  24. `--allow-root=ROOTDIR'
  25.      Specify legal CVSROOT directory.  See *Note Password
  26.      authentication server::.
  27.      Authenticate all communication between the client and the server.
  28.      Only has an effect on the CVS client.  As of this writing, this is
  29.      only implemented when using a GSSAPI connection (*note GSSAPI
  30.      authenticated::.).  Authentication prevents certain sorts of
  31.      attacks involving hijacking the active TCP connection.  Enabling
  32.      authentication does not enable encryption.
  33. `-b BINDIR'
  34.      In CVS 1.9.18 and older, this specified that RCS programs are in
  35.      the BINDIR directory.  Current versions of CVS do not run RCS
  36.      programs; for compatibility this option is accepted, but it does
  37.      nothing.
  38. `-T TEMPDIR'
  39.      Use TEMPDIR as the directory where temporary files are located.
  40.      Overrides the setting of the `$TMPDIR' environment variable and
  41.      any precompiled directory.  This parameter should be specified as
  42.      an absolute pathname.
  43. `-d CVS_ROOT_DIRECTORY'
  44.      Use CVS_ROOT_DIRECTORY as the root directory pathname of the
  45.      repository.  Overrides the setting of the `$CVSROOT' environment
  46.      variable.  *Note Repository::.
  47. `-e EDITOR'
  48.      Use EDITOR to enter revision log information.  Overrides the
  49.      setting of the `$CVSEDITOR' and `$EDITOR' environment variables.
  50.      For more information, see *Note Committing your changes::.
  51.      Do not read the `~/.cvsrc' file.  This option is most often used
  52.      because of the non-orthogonality of the CVS option set.  For
  53.      example, the `cvs log' option `-N' (turn off display of tag names)
  54.      does not have a corresponding option to turn the display on.  So
  55.      if you have `-N' in the `~/.cvsrc' entry for `log', you may need
  56.      to use `-f' to show the tag names.
  57. `--help'
  58.      Display usage information about the specified `cvs_command' (but
  59.      do not actually execute the command).  If you don't specify a
  60.      command name, `cvs -H' displays overall help for CVS, including a
  61.      list of other help options.
  62.      Do not log the `cvs_command' in the command history (but execute it
  63.      anyway).  *Note history::, for information on command history.
  64.      Do not change any files.  Attempt to execute the `cvs_command',
  65.      but only to issue reports; do not remove, update, or merge any
  66.      existing files, or create any new files.
  67.      Note that CVS will not necessarily produce exactly the same output
  68.      as without `-n'.  In some cases the output will be the same, but
  69.      in other cases CVS will skip some of the processing that would
  70.      have been required to produce the exact same output.
  71.      Cause the command to be really quiet; the command will only
  72.      generate output for serious problems.
  73.      Cause the command to be somewhat quiet; informational messages,
  74.      such as reports of recursion through subdirectories, are
  75.      suppressed.
  76.      Make new working files read-only.  Same effect as if the
  77.      `$CVSREAD' environment variable is set (*note Environment
  78.      variables::.).  The default is to make working files writable,
  79.      unless watches are on (*note Watches::.).
  80. `-s VARIABLE=VALUE'
  81.      Set a user variable (*note Variables::.).
  82.      Trace program execution; display messages showing the steps of CVS
  83.      activity.  Particularly useful with `-n' to explore the potential
  84.      impact of an unfamiliar command.
  85. `--version'
  86.      Display version and copyright information for CVS.
  87.      Make new working files read-write.  Overrides the setting of the
  88.      `$CVSREAD' environment variable.  Files are created read-write by
  89.      default, unless `$CVSREAD' is set or `-r' is given.
  90.      Encrypt all communication between the client and the server.  Only
  91.      has an effect on the CVS client.  As of this writing, this is only
  92.      implemented when using a GSSAPI connection (*note GSSAPI
  93.      authenticated::.) or a Kerberos connection (*note Kerberos
  94.      authenticated::.).  Enabling encryption implies that message
  95.      traffic is also authenticated.  Encryption support is not
  96.      available by default; it must be enabled using a special configure
  97.      option, `--enable-encryption', when you build CVS.
  98. `-z GZIP-LEVEL'
  99.      Set the compression level.  Only has an effect on the CVS client.
  100. File: cvs.info,  Node: Common options,  Next: admin,  Prev: Global options,  Up: CVS commands
  101. Common command options
  102. ======================
  103.    This section describes the `command_options' that are available
  104. across several CVS commands.  These options are always given to the
  105. right of `cvs_command'. Not all commands support all of these options;
  106. each option is only supported for commands where it makes sense.
  107. However, when a command has one of these options you can almost always
  108. count on the same behavior of the option as in other commands.  (Other
  109. command options, which are listed with the individual commands, may have
  110. different behavior from one CVS command to the other).
  111.    *Warning:* the `history' command is an exception; it supports many
  112. options that conflict even with these standard options.
  113. `-D DATE_SPEC'
  114.      Use the most recent revision no later than DATE_SPEC.  DATE_SPEC
  115.      is a single argument, a date description specifying a date in the
  116.      past.
  117.      The specification is "sticky" when you use it to make a private
  118.      copy of a source file; that is, when you get a working file using
  119.      `-D', CVS records the date you specified, so that further updates
  120.      in the same directory will use the same date (for more information
  121.      on sticky tags/dates, *note Sticky tags::.).
  122.      `-D' is available with the `checkout', `diff', `export', `history',
  123.      `rdiff', `rtag', and `update' commands.  (The `history' command
  124.      uses this option in a slightly different way; *note history
  125.      options::.).
  126.      A wide variety of date formats are supported by CVS.  The most
  127.      standard ones are ISO8601 (from the International Standards
  128.      Organization) and the Internet e-mail standard (specified in
  129.      RFC822 as amended by RFC1123).
  130.      ISO8601 dates have many variants but a few examples are:
  131.           1972-09-24
  132.           1972-09-24 20:05
  133.      For more details about ISO8601 dates, see:
  134.           http://www.ft.uni-erlangen.de/~mskuhn/iso-time.html
  135.      In addition to the dates allowed in Internet e-mail itself, CVS
  136.      also allows some of the fields to be omitted.  For example:
  137.           24 Sep 1972 20:05
  138.           24 Sep
  139.      The date is interpreted as being in the local timezone, unless a
  140.      specific timezone is specified.
  141.      These two date formats are preferred.  However, CVS currently
  142.      accepts a wide variety of other date formats.  They are
  143.      intentionally not documented here in any detail, and future
  144.      versions of CVS might not accept all of them.
  145.      One such format is `MONTH/DAY/YEAR'.  This may confuse people who
  146.      are accustomed to having the month and day in the other order;
  147.      `1/4/96' is January 4, not April 1.
  148.      Remember to quote the argument to the `-D' flag so that your shell
  149.      doesn't interpret spaces as argument separators.  A command using
  150.      the `-D' flag can look like this:
  151.           $ cvs diff -D "1 hour ago" cvs.texinfo
  152.      When you specify a particular date or tag to CVS commands, they
  153.      normally ignore files that do not contain the tag (or did not
  154.      exist prior to the date) that you specified.  Use the `-f' option
  155.      if you want files retrieved even when there is no match for the
  156.      tag or date.  (The most recent revision of the file will be used).
  157.      `-f' is available with these commands: `annotate', `checkout',
  158.      `export', `rdiff', `rtag', and `update'.
  159.      *Warning:*  The `commit' and `remove' commands also have a `-f'
  160.      option, but it has a different behavior for those commands.  See
  161.      *Note commit options::, and *Note Removing files::.
  162. `-k KFLAG'
  163.      Alter the default processing of keywords.  *Note Keyword
  164.      substitution::, for the meaning of KFLAG.  Your KFLAG
  165.      specification is "sticky" when you use it to create a private copy
  166.      of a source file; that is, when you use this option with the
  167.      `checkout' or `update' commands, CVS associates your selected
  168.      KFLAG with the file, and continues to use it with future update
  169.      commands on the same file until you specify otherwise.
  170.      The `-k' option is available with the `add', `checkout', `diff',
  171.      `import' and `update' commands.
  172.      Local; run only in current working directory, rather than
  173.      recursing through subdirectories.
  174.      *Warning:* this is not the same as the overall `cvs -l' option,
  175.      which you can specify to the left of a cvs command!
  176.      Available with the following commands: `annotate', `checkout',
  177.      `commit', `diff', `edit', `editors', `export', `log', `rdiff',
  178.      `remove', `rtag', `status', `tag', `unedit', `update', `watch',
  179.      and `watchers'.
  180. `-m MESSAGE'
  181.      Use MESSAGE as log information, instead of invoking an editor.
  182.      Available with the following commands: `add', `commit' and
  183.      `import'.
  184.      Do not run any checkout/commit/tag program.  (A program can be
  185.      specified to run on each of these activities, in the modules
  186.      database (*note modules::.); this option bypasses it).
  187.      *Warning:* this is not the same as the overall `cvs -n' option,
  188.      which you can specify to the left of a cvs command!
  189.      Available with the `checkout', `commit', `export', and `rtag'
  190.      commands.
  191.      Prune empty directories.  See *Note Removing directories::.
  192.      Pipe the files retrieved from the repository to standard output,
  193.      rather than writing them in the current directory.  Available with
  194.      the `checkout' and `update' commands.
  195.      Process directories recursively.  This is on by default.
  196.      Available with the following commands: `annotate', `checkout',
  197.      `commit', `diff', `edit', `editors', `export', `rdiff', `remove',
  198.      `rtag', `status', `tag', `unedit', `update', `watch', and
  199.      `watchers'.
  200. `-r TAG'
  201.      Use the revision specified by the TAG argument instead of the
  202.      default "head" revision.  As well as arbitrary tags defined with
  203.      the `tag' or `rtag' command, two special tags are always
  204.      available: `HEAD' refers to the most recent version available in
  205.      the repository, and `BASE' refers to the revision you last checked
  206.      out into the current working directory.
  207.      The tag specification is sticky when you use this with `checkout'
  208.      or `update' to make your own copy of a file: CVS remembers the tag
  209.      and continues to use it on future update commands, until you
  210.      specify otherwise (for more information on sticky tags/dates,
  211.      *note Sticky tags::.).  The tag can be either a symbolic or
  212.      numeric tag.  *Note Tags::.
  213.      Specifying the `-q' global option along with the `-r' command
  214.      option is often useful, to suppress the warning messages when the
  215.      RCS file does not contain the specified tag.
  216.      *Warning:* this is not the same as the overall `cvs -r' option,
  217.      which you can specify to the left of a CVS command!
  218.      `-r' is available with the `checkout', `commit', `diff',
  219.      `history', `export', `rdiff', `rtag', and `update' commands.
  220.      Specify file names that should be filtered.  You can use this
  221.      option repeatedly.  The spec can be a file name pattern of the
  222.      same type that you can specify in the `.cvswrappers' file.
  223.      Available with the following commands: `import', and `update'.
  224. File: cvs.info,  Node: admin,  Next: checkout,  Prev: Common options,  Up: CVS commands
  225. admin--Administration
  226. =====================
  227.    * Requires: repository, working directory.
  228.    * Changes: repository.
  229.    * Synonym: rcs
  230.    This is the CVS interface to assorted administrative facilities.
  231. Some of them have questionable usefulness for CVS but exist for
  232. historical purposes.  Some of the questionable options are likely to
  233. disappear in the future.  This command *does* work recursively, so
  234. extreme care should be used.
  235.    On unix, if there is a group named `cvsadmin', only members of that
  236. group can run `cvs admin'.  This group should exist on the server, or
  237. any system running the non-client/server CVS.  To disallow `cvs admin'
  238. for all users, create a group with no users in it.  On NT, the
  239. `cvsadmin' feature does not exist and all users can run `cvs admin'.
  240. * Menu:
  241. * admin options::               admin options
  242. File: cvs.info,  Node: admin options,  Up: admin
  243. admin options
  244. -------------
  245.    Some of these options have questionable usefulness for CVS but exist
  246. for historical purposes.  Some even make it impossible to use CVS until
  247. you undo the effect!
  248. `-AOLDFILE'
  249.      Might not work together with CVS.  Append the access list of
  250.      OLDFILE to the access list of the RCS file.
  251. `-aLOGINS'
  252.      Might not work together with CVS.  Append the login names
  253.      appearing in the comma-separated list LOGINS to the access list of
  254.      the RCS file.
  255. `-b[REV]'
  256.      Set the default branch to REV.  In CVS, you normally do not
  257.      manipulate default branches; sticky tags (*note Sticky tags::.)
  258.      are a better way to decide which branch you want to work on.
  259.      There is one reason to run `cvs admin -b': to revert to the
  260.      vendor's version when using vendor branches (*note Reverting local
  261.      changes::.).  There can be no space between `-b' and its argument.
  262. `-cSTRING'
  263.      Sets the comment leader to STRING.  The comment leader is not used
  264.      by current versions of CVS or RCS 5.7.  Therefore, you can almost
  265.      surely not worry about it.  *Note Keyword substitution::.
  266. `-e[LOGINS]'
  267.      Might not work together with CVS.  Erase the login names appearing
  268.      in the comma-separated list LOGINS from the access list of the RCS
  269.      file.  If LOGINS is omitted, erase the entire access list.
  270.      Run interactively, even if the standard input is not a terminal.
  271.      This option does not work with the client/server CVS and is likely
  272.      to disappear in a future release of CVS.
  273.      Useless with CVS.  This creates and initializes a new RCS file,
  274.      without depositing a revision.  With CVS, add files with the `cvs
  275.      add' command (*note Adding files::.).
  276. `-kSUBST'
  277.      Set the default keyword substitution to SUBST.  *Note Keyword
  278.      substitution::.  Giving an explicit `-k' option to `cvs update',
  279.      `cvs export', or `cvs checkout' overrides this default.
  280. `-l[REV]'
  281.      Lock the revision with number REV.  If a branch is given, lock the
  282.      latest revision on that branch.  If REV is omitted, lock the
  283.      latest revision on the default branch.  There can be no space
  284.      between `-l' and its argument.
  285.      This can be used in conjunction with the `rcslock.pl' script in
  286.      the `contrib' directory of the CVS source distribution to provide
  287.      reserved checkouts (where only one user can be editing a given
  288.      file at a time).  See the comments in that file for details (and
  289.      see the `README' file in that directory for disclaimers about the
  290.      unsupported nature of contrib).  According to comments in that
  291.      file, locking must set to strict (which is the default).
  292.      Set locking to strict.  Strict locking means that the owner of an
  293.      RCS file is not exempt from locking for checkin.  For use with
  294.      CVS, strict locking must be set; see the discussion under the `-l'
  295.      option above.
  296. `-mREV:MSG'
  297.      Replace the log message of revision REV with MSG.
  298. `-NNAME[:[REV]]'
  299.      Act like `-n', except override any previous assignment of NAME.
  300.      For use with magic branches, see *Note Magic branch numbers::.
  301. `-nNAME[:[REV]]'
  302.      Associate the symbolic name NAME with the branch or revision REV.
  303.      It is normally better to use `cvs tag' or `cvs rtag' instead.
  304.      Delete the symbolic name if both `:' and REV are omitted;
  305.      otherwise, print an error message if NAME is already associated
  306.      with another number.  If REV is symbolic, it is expanded before
  307.      association.  A REV consisting of a branch number followed by a
  308.      `.' stands for the current latest revision in the branch.  A `:'
  309.      with an empty REV stands for the current latest revision on the
  310.      default branch, normally the trunk.  For example, `cvs admin
  311.      -nNAME:' associates NAME with the current latest revision of all
  312.      the RCS files; this contrasts with `cvs admin -nNAME:$' which
  313.      associates NAME with the revision numbers extracted from keyword
  314.      strings in the corresponding working files.
  315. `-oRANGE'
  316.      Deletes ("outdates") the revisions given by RANGE.
  317.      Note that this command can be quite dangerous unless you know
  318.      *exactly* what you are doing (for example see the warnings below
  319.      about how the REV1:REV2 syntax is confusing).
  320.      If you are short on disc this option might help you.  But think
  321.      twice before using it--there is no way short of restoring the
  322.      latest backup to undo this command!  If you delete different
  323.      revisions than you planned, either due to carelessness or (heaven
  324.      forbid) a CVS bug, there is no opportunity to correct the error
  325.      before the revisions are deleted.  It probably would be a good
  326.      idea to experiment on a copy of the repository first.
  327.      Specify RANGE in one of the following ways:
  328.     `REV1::REV2'
  329.           Collapse all revisions between rev1 and rev2, so that CVS
  330.           only stores the differences associated with going from rev1
  331.           to rev2, not intermediate steps.  For example, after `-o
  332.           1.3::1.5' one can retrieve revision 1.3, revision 1.5, or the
  333.           differences to get from 1.3 to 1.5, but not the revision 1.4,
  334.           or the differences between 1.3 and 1.4.  Other examples: `-o
  335.           1.3::1.4' and `-o 1.3::1.3' have no effect, because there are
  336.           no intermediate revisions to remove.
  337.     `::REV'
  338.           Collapse revisions between the beginning of the branch
  339.           containing REV and REV itself.  The branchpoint and REV are
  340.           left intact.  For example, `-o ::1.3.2.6' deletes revision
  341.           1.3.2.1, revision 1.3.2.5, and everything in between, but
  342.           leaves 1.3 and 1.3.2.6 intact.
  343.     `REV::'
  344.           Collapse revisions between REV and the end of the branch
  345.           containing REV.  Revision REV is left intact but the head
  346.           revision is deleted.
  347.     `REV'
  348.           Delete the revision REV.  For example, `-o 1.3' is equivalent
  349.           to `-o 1.2::1.4'.
  350.     `REV1:REV2'
  351.           Delete the revisions from REV1 to REV2, inclusive, on the
  352.           same branch.  One will not be able to retrieve REV1 or REV2
  353.           or any of the revisions in between.  For example, the command
  354.           `cvs admin -oR_1_01:R_1_02 .' is rarely useful.  It means to
  355.           delete revisions up to, and including, the tag R_1_02.  But
  356.           beware!  If there are files that have not changed between
  357.           R_1_02 and R_1_03 the file will have *the same* numerical
  358.           revision number assigned to the tags R_1_02 and R_1_03.  So
  359.           not only will it be impossible to retrieve R_1_02; R_1_03
  360.           will also have to be restored from the tapes!  In most cases
  361.           you want to specify REV1::REV2 instead.
  362.     `:REV'
  363.           Delete revisions from the beginning of the branch containing
  364.           REV up to and including REV.
  365.     `REV:'
  366.           Delete revisions from revision REV, including REV itself, to
  367.           the end of the branch containing REV.
  368.      None of the revisions to be deleted may have branches or locks.
  369.      If any of the revisions to be deleted have symbolic names, and one
  370.      specifies one of the `::' syntaxes, then CVS will give an error
  371.      and not delete any revisions.  If you really want to delete both
  372.      the symbolic names and the revisions, first delete the symbolic
  373.      names with `cvs tag -d', then run `cvs admin -o'.  If one
  374.      specifies the non-`::' syntaxes, then CVS will delete the
  375.      revisions but leave the symbolic names pointing to nonexistent
  376.      revisions.  This behavior is preserved for compatibility with
  377.      previous versions of CVS, but because it isn't very useful, in the
  378.      future it may change to be like the `::' case.
  379.      Due to the way CVS handles branches REV cannot be specified
  380.      symbolically if it is a branch.  *Note Magic branch numbers::, for
  381.      an explanation.
  382.      Make sure that no-one has checked out a copy of the revision you
  383.      outdate.  Strange things will happen if he starts to edit it and
  384.      tries to check it back in.  For this reason, this option is not a
  385.      good way to take back a bogus commit; commit a new revision
  386.      undoing the bogus change instead (*note Merging two revisions::.).
  387.      Run quietly; do not print diagnostics.
  388. `-sSTATE[:REV]'
  389.      Useful with CVS.  Set the state attribute of the revision REV to
  390.      STATE.  If REV is a branch number, assume the latest revision on
  391.      that branch.  If REV is omitted, assume the latest revision on the
  392.      default branch.  Any identifier is acceptable for STATE.  A useful
  393.      set of states is `Exp' (for experimental), `Stab' (for stable),
  394.      and `Rel' (for released).  By default, the state of a new revision
  395.      is set to `Exp' when it is created.  The state is visible in the
  396.      output from CVS LOG (*note log::.), and in the `$Log$' and
  397.      `$State$' keywords (*note Keyword substitution::.).  Note that CVS
  398.      uses the `dead' state for its own purposes; to take a file to or
  399.      from the `dead' state use commands like `cvs remove' and `cvs
  400.      add', not `cvs admin -s'.
  401. `-t[FILE]'
  402.      Useful with CVS.  Write descriptive text from the contents of the
  403.      named FILE into the RCS file, deleting the existing text.  The
  404.      FILE pathname may not begin with `-'.  The descriptive text can be
  405.      seen in the output from `cvs log' (*note log::.).  There can be no
  406.      space between `-t' and its argument.
  407.      If FILE is omitted, obtain the text from standard input,
  408.      terminated by end-of-file or by a line containing `.' by itself.
  409.      Prompt for the text if interaction is possible; see `-I'.  Reading
  410.      from standard input does not work for client/server CVS and may
  411.      change in a future release of CVS.
  412. `-t-STRING'
  413.      Similar to `-tFILE'. Write descriptive text from the STRING into
  414.      the RCS file, deleting the existing text.  There can be no space
  415.      between `-t' and its argument.
  416.      Set locking to non-strict.  Non-strict locking means that the
  417.      owner of a file need not lock a revision for checkin.  For use
  418.      with CVS, strict locking must be set; see the discussion under the
  419.      `-l' option above.
  420. `-u[REV]'
  421.      See the option `-l' above, for a discussion of using this option
  422.      with CVS.  Unlock the revision with number REV.  If a branch is
  423.      given, unlock the latest revision on that branch.  If REV is
  424.      omitted, remove the latest lock held by the caller.  Normally,
  425.      only the locker of a revision may unlock it.  Somebody else
  426.      unlocking a revision breaks the lock.  This causes a mail message
  427.      to be sent to the original locker.  The message contains a
  428.      commentary solicited from the breaker.  The commentary is
  429.      terminated by end-of-file or by a line containing `.' by itself.
  430.      There can be no space between `-u' and its argument.
  431. `-VN'
  432.      In previous versions of CVS, this option meant to write an RCS
  433.      file which would be acceptable to RCS version N, but it is now
  434.      obsolete and specifying it will produce an error.
  435. `-xSUFFIXES'
  436.      In previous versions of CVS, this was documented as a way of
  437.      specifying the names of the RCS files.  However, CVS has always
  438.      required that the RCS files used by CVS end in `,v', so this
  439.      option has never done anything useful.
  440. File: cvs.info,  Node: checkout,  Next: commit,  Prev: admin,  Up: CVS commands
  441. checkout--Check out sources for editing
  442. =======================================
  443.    * Synopsis: checkout [options] modules...
  444.    * Requires: repository.
  445.    * Changes: working directory.
  446.    * Synonyms: co, get
  447.    Create or update a working directory containing copies of the source
  448. files specified by MODULES.  You must execute `checkout' before using
  449. most of the other CVS commands, since most of them operate on your
  450. working directory.
  451.    The MODULES are either symbolic names for some collection of source
  452. directories and files, or paths to directories or files in the
  453. repository.  The symbolic names are defined in the `modules' file.
  454. *Note modules::.
  455.    Depending on the modules you specify, `checkout' may recursively
  456. create directories and populate them with the appropriate source files.
  457. You can then edit these source files at any time (regardless of
  458. whether other software developers are editing their own copies of the
  459. sources); update them to include new changes applied by others to the
  460. source repository; or commit your work as a permanent change to the
  461. source repository.
  462.    Note that `checkout' is used to create directories.  The top-level
  463. directory created is always added to the directory where `checkout' is
  464. invoked, and usually has the same name as the specified module.  In the
  465. case of a module alias, the created sub-directory may have a different
  466. name, but you can be sure that it will be a sub-directory, and that
  467. `checkout' will show the relative path leading to each file as it is
  468. extracted into your private work area (unless you specify the `-Q'
  469. global option).
  470.    The files created by `checkout' are created read-write, unless the
  471. `-r' option to CVS (*note Global options::.) is specified, the
  472. `CVSREAD' environment variable is specified (*note Environment
  473. variables::.), or a watch is in effect for that file (*note Watches::.).
  474.    Note that running `checkout' on a directory that was already built
  475. by a prior `checkout' is also permitted.  This is similar to specifying
  476. the `-d' option to the `update' command in the sense that new
  477. directories that have been created in the repository will appear in
  478. your work area.  However, `checkout' takes a module name whereas
  479. `update' takes a directory name.  Also to use `checkout' this way it
  480. must be run from the top level directory (where you originally ran
  481. `checkout' from), so before you run `checkout' to update an existing
  482. directory, don't forget to change your directory to the top level
  483. directory.
  484.    For the output produced by the `checkout' command see *Note update
  485. output::.
  486. * Menu:
  487. * checkout options::            checkout options
  488. * checkout examples::           checkout examples
  489. File: cvs.info,  Node: checkout options,  Next: checkout examples,  Up: checkout
  490. checkout options
  491. ----------------
  492.    These standard options are supported by `checkout' (*note Common
  493. options::., for a complete description of them):
  494. `-D DATE'
  495.      Use the most recent revision no later than DATE.  This option is
  496.      sticky, and implies `-P'.  See *Note Sticky tags::, for more
  497.      information on sticky tags/dates.
  498.      Only useful with the `-D DATE' or `-r TAG' flags.  If no matching
  499.      revision is found, retrieve the most recent revision (instead of
  500.      ignoring the file).
  501. `-k KFLAG'
  502.      Process keywords according to KFLAG.  See *Note Keyword
  503.      substitution::.  This option is sticky; future updates of this
  504.      file in this working directory will use the same KFLAG.  The
  505.      `status' command can be viewed to see the sticky options.  See
  506.      *Note Invoking CVS::, for more information on the `status' command.
  507.      Local; run only in current working directory.
  508.      Do not run any checkout program (as specified with the `-o' option
  509.      in the modules file; *note modules::.).
  510.      Prune empty directories.  See *Note Moving directories::.
  511.      Pipe files to the standard output.
  512.      Checkout directories recursively.  This option is on by default.
  513. `-r TAG'
  514.      Use revision TAG.  This option is sticky, and implies `-P'.  See
  515.      *Note Sticky tags::, for more information on sticky tags/dates.
  516.    In addition to those, you can use these special command options with
  517. `checkout':
  518.      Reset any sticky tags, dates, or `-k' options.  See *Note Sticky
  519.      tags::, for more information on sticky tags/dates.
  520.      Copy the module file, sorted, to the standard output, instead of
  521.      creating or modifying any files or directories in your working
  522.      directory.
  523. `-d DIR'
  524.      Create a directory called DIR for the working files, instead of
  525.      using the module name.  In general, using this flag is equivalent
  526.      to using `mkdir DIR; cd DIR' followed by the checkout command
  527.      without the `-d' flag.
  528.      There is an important exception, however.  It is very convenient
  529.      when checking out a single item to have the output appear in a
  530.      directory that doesn't contain empty intermediate directories.  In
  531.      this case *only*, CVS tries to "shorten" pathnames to avoid those
  532.      empty directories.
  533.      For example, given a module `foo' that contains the file `bar.c',
  534.      the command `cvs co -d dir foo' will create directory `dir' and
  535.      place `bar.c' inside.  Similarly, given a module `bar' which has
  536.      subdirectory `baz' wherein there is a file `quux.c', the command
  537.      `cvs -d dir co bar/baz' will create directory `dir' and place
  538.      `quux.c' inside.
  539.      Using the `-N' flag will defeat this behavior.  Given the same
  540.      module definitions above, `cvs co -N -d dir foo' will create
  541.      directories `dir/foo' and place `bar.c' inside, while `cvs co -N -d
  542.      dir bar/baz' will create directories `dir/bar/baz' and place
  543.      `quux.c' inside.
  544. `-j TAG'
  545.      With two `-j' options, merge changes from the revision specified
  546.      with the first `-j' option to the revision specified with the
  547.      second `j' option, into the working directory.
  548.      With one `-j' option, merge changes from the ancestor revision to
  549.      the revision specified with the `-j' option, into the working
  550.      directory.  The ancestor revision is the common ancestor of the
  551.      revision which the working directory is based on, and the revision
  552.      specified in the `-j' option.
  553.      In addition, each -j option can contain an optional date
  554.      specification which, when used with branches, can limit the chosen
  555.      revision to one within a specific date.  An optional date is
  556.      specified by adding a colon (:) to the tag:
  557.      `-jSYMBOLIC_TAG:DATE_SPECIFIER'.
  558.      *Note Branching and merging::.
  559.      Only useful together with `-d DIR'.  With this option, CVS will
  560.      not "shorten" module paths in your working directory when you
  561.      check out a single module.  See the `-d' flag for examples and a
  562.      discussion.
  563.      Like `-c', but include the status of all modules, and sort it by
  564.      the status string.  *Note modules::, for info about the `-s'
  565.      option that is used inside the modules file to set the module
  566.      status.
  567. File: cvs.info,  Node: checkout examples,  Prev: checkout options,  Up: checkout
  568. checkout examples
  569. -----------------
  570.    Get a copy of the module `tc':
  571.      $ cvs checkout tc
  572.    Get a copy of the module `tc' as it looked one day ago:
  573.      $ cvs checkout -D yesterday tc
  574. File: cvs.info,  Node: commit,  Next: diff,  Prev: checkout,  Up: CVS commands
  575. commit--Check files into the repository
  576. =======================================
  577.    * Synopsis: commit [-lnRf] [-m 'log_message' | -F file] [-r
  578.      revision] [files...]
  579.    * Requires: working directory, repository.
  580.    * Changes: repository.
  581.    * Synonym: ci
  582.    Use `commit' when you want to incorporate changes from your working
  583. source files into the source repository.
  584.    If you don't specify particular files to commit, all of the files in
  585. your working current directory are examined.  `commit' is careful to
  586. change in the repository only those files that you have really changed.
  587. By default (or if you explicitly specify the `-R' option), files in
  588. subdirectories are also examined and committed if they have changed;
  589. you can use the `-l' option to limit `commit' to the current directory
  590. only.
  591.    `commit' verifies that the selected files are up to date with the
  592. current revisions in the source repository; it will notify you, and
  593. exit without committing, if any of the specified files must be made
  594. current first with `update' (*note update::.).  `commit' does not call
  595. the `update' command for you, but rather leaves that for you to do when
  596. the time is right.
  597.    When all is well, an editor is invoked to allow you to enter a log
  598. message that will be written to one or more logging programs (*note
  599. modules::., and *note loginfo::.) and placed in the RCS file inside the
  600. repository.  This log message can be retrieved with the `log' command;
  601. see *Note log::.  You can specify the log message on the command line
  602. with the `-m MESSAGE' option, and thus avoid the editor invocation, or
  603. use the `-F FILE' option to specify that the argument file contains the
  604. log message.
  605. * Menu:
  606. * commit options::              commit options
  607. * commit examples::             commit examples
  608. File: cvs.info,  Node: commit options,  Next: commit examples,  Up: commit
  609. commit options
  610. --------------
  611.    These standard options are supported by `commit' (*note Common
  612. options::., for a complete description of them):
  613.      Local; run only in current working directory.
  614.      Do not run any module program.
  615.      Commit directories recursively.  This is on by default.
  616. `-r REVISION'
  617.      Commit to REVISION.  REVISION must be either a branch, or a
  618.      revision on the main trunk that is higher than any existing
  619.      revision number (*note Assigning revisions::.).  You cannot commit
  620.      to a specific revision on a branch.
  621.    `commit' also supports these options:
  622. `-F FILE'
  623.      Read the log message from FILE, instead of invoking an editor.
  624.      Note that this is not the standard behavior of the `-f' option as
  625.      defined in *Note Common options::.
  626.      Force CVS to commit a new revision even if you haven't made any
  627.      changes to the file.  If the current revision of FILE is 1.7, then
  628.      the following two commands are equivalent:
  629.           $ cvs commit -f FILE
  630.           $ cvs commit -r 1.8 FILE
  631.      The `-f' option disables recursion (i.e., it implies `-l').  To
  632.      force CVS to commit a new revision for all files in all
  633.      subdirectories, you must use `-f -R'.
  634. `-m MESSAGE'
  635.      Use MESSAGE as the log message, instead of invoking an editor.
  636. File: cvs.info,  Node: commit examples,  Prev: commit options,  Up: commit
  637. commit examples
  638. ---------------
  639. Committing to a branch
  640. ......................
  641.    You can commit to a branch revision (one that has an even number of
  642. dots) with the `-r' option.  To create a branch revision, use the `-b'
  643. option of the `rtag' or `tag' commands (*note tag::.  or *note
  644. rtag::.).  Then, either `checkout' or `update' can be used to base your
  645. sources on the newly created branch.  From that point on, all `commit'
  646. changes made within these working sources will be automatically added
  647. to a branch revision, thereby not disturbing main-line development in
  648. any way.  For example, if you had to create a patch to the 1.2 version
  649. of the product, even though the 2.0 version is already under
  650. development, you might do:
  651.      $ cvs rtag -b -r FCS1_2 FCS1_2_Patch product_module
  652.      $ cvs checkout -r FCS1_2_Patch product_module
  653.      $ cd product_module
  654.      [[ hack away ]]
  655.      $ cvs commit
  656. This works automatically since the `-r' option is sticky.
  657. Creating the branch after editing
  658. .................................
  659.    Say you have been working on some extremely experimental software,
  660. based on whatever revision you happened to checkout last week.  If
  661. others in your group would like to work on this software with you, but
  662. without disturbing main-line development, you could commit your change
  663. to a new branch.  Others can then checkout your experimental stuff and
  664. utilize the full benefit of CVS conflict resolution.  The scenario might
  665. look like:
  666.      [[ hacked sources are present ]]
  667.      $ cvs tag -b EXPR1
  668.      $ cvs update -r EXPR1
  669.      $ cvs commit
  670.    The `update' command will make the `-r EXPR1' option sticky on all
  671. files.  Note that your changes to the files will never be removed by the
  672. `update' command.  The `commit' will automatically commit to the
  673. correct branch, because the `-r' is sticky.  You could also do like
  674. this:
  675.      [[ hacked sources are present ]]
  676.      $ cvs tag -b EXPR1
  677.      $ cvs commit -r EXPR1
  678. but then, only those files that were changed by you will have the `-r
  679. EXPR1' sticky flag.  If you hack away, and commit without specifying
  680. the `-r EXPR1' flag, some files may accidentally end up on the main
  681. trunk.
  682.    To work with you on the experimental change, others would simply do
  683.      $ cvs checkout -r EXPR1 whatever_module
  684. File: cvs.info,  Node: diff,  Next: export,  Prev: commit,  Up: CVS commands
  685. diff--Show differences between revisions
  686. ========================================
  687.    * Synopsis: diff [-lR] [format_options] [[-r rev1 | -D date1] [-r
  688.      rev2 |  -D date2]] [files...]
  689.    * Requires: working directory, repository.
  690.    * Changes: nothing.
  691.    The `diff' command is used to compare different revisions of files.
  692. The default action is to compare your working files with the revisions
  693. they were based on, and report any differences that are found.
  694.    If any file names are given, only those files are compared.  If any
  695. directories are given, all files under them will be compared.
  696.    The exit status for diff is different than for other CVS commands;
  697. for details *Note Exit status::.
  698. * Menu:
  699. * diff options::                diff options
  700. * diff examples::               diff examples
  701. File: cvs.info,  Node: diff options,  Next: diff examples,  Up: diff
  702. diff options
  703. ------------
  704.    These standard options are supported by `diff' (*note Common
  705. options::., for a complete description of them):
  706. `-D DATE'
  707.      Use the most recent revision no later than DATE.  See `-r' for how
  708.      this affects the comparison.
  709. `-k KFLAG'
  710.      Process keywords according to KFLAG.  See *Note Keyword
  711.      substitution::.
  712.      Local; run only in current working directory.
  713.      Examine directories recursively.  This option is on by default.
  714. `-r TAG'
  715.      Compare with revision TAG.  Zero, one or two `-r' options can be
  716.      present.  With no `-r' option, the working file will be compared
  717.      with the revision it was based on.  With one `-r', that revision
  718.      will be compared to your current working file.  With two `-r'
  719.      options those two revisions will be compared (and your working
  720.      file will not affect the outcome in any way).
  721.      One or both `-r' options can be replaced by a `-D DATE' option,
  722.      described above.
  723.    The following options specify the format of the output.  They have
  724. the same meaning as in GNU diff.
  725.      -0 -1 -2 -3 -4 -5 -6 -7 -8 -9
  726.      --binary
  727.      --brief
  728.      --changed-group-format=ARG
  729.      -c
  730.        -C NLINES
  731.        --context[=LINES]
  732.      -e --ed
  733.      -t --expand-tabs
  734.      -f --forward-ed
  735.      --horizon-lines=ARG
  736.      --ifdef=ARG
  737.      -w --ignore-all-space
  738.      -B --ignore-blank-lines
  739.      -i --ignore-case
  740.      -I REGEXP
  741.         --ignore-matching-lines=REGEXP
  742.      -h
  743.      -b --ignore-space-change
  744.      -T --initial-tab
  745.      -L LABEL
  746.        --label=LABEL
  747.      --left-column
  748.      -d --minimal
  749.      -N --new-file
  750.      --new-line-format=ARG
  751.      --old-line-format=ARG
  752.      --paginate
  753.      -n --rcs
  754.      -s --report-identical-files
  755.      -p
  756.      --show-c-function
  757.      -y --side-by-side
  758.      -F REGEXP
  759.      --show-function-line=REGEXP
  760.      -H --speed-large-files
  761.      --suppress-common-lines
  762.      -a --text
  763.      --unchanged-group-format=ARG
  764.      -u
  765.        -U NLINES
  766.        --unified[=LINES]
  767.      -V ARG
  768.      -W COLUMNS
  769.        --width=COLUMNS
  770. File: cvs.info,  Node: diff examples,  Prev: diff options,  Up: diff
  771. diff examples
  772. -------------
  773.    The following line produces a Unidiff (`-u' flag) between revision
  774. 1.14 and 1.19 of `backend.c'.  Due to the `-kk' flag no keywords are
  775. substituted, so differences that only depend on keyword substitution
  776. are ignored.
  777.      $ cvs diff -kk -u -r 1.14 -r 1.19 backend.c
  778.    Suppose the experimental branch EXPR1 was based on a set of files
  779. tagged RELEASE_1_0.  To see what has happened on that branch, the
  780. following can be used:
  781.      $ cvs diff -r RELEASE_1_0 -r EXPR1
  782.    A command like this can be used to produce a context diff between
  783. two releases:
  784.      $ cvs diff -c -r RELEASE_1_0 -r RELEASE_1_1 > diffs
  785.    If you are maintaining ChangeLogs, a command like the following just
  786. before you commit your changes may help you write the ChangeLog entry.
  787. All local modifications that have not yet been committed will be
  788. printed.
  789.      $ cvs diff -u | less
  790. File: cvs.info,  Node: export,  Next: history,  Prev: diff,  Up: CVS commands
  791. export--Export sources from CVS, similar to checkout
  792. ====================================================
  793.    * Synopsis: export [-flNnR] [-r rev|-D date] [-k subst] [-d dir]
  794.      module...
  795.    * Requires: repository.
  796.    * Changes: current directory.
  797.    This command is a variant of `checkout'; use it when you want a copy
  798. of the source for module without the CVS administrative directories.
  799. For example, you might use `export' to prepare source for shipment
  800. off-site.  This command requires that you specify a date or tag (with
  801. `-D' or `-r'), so that you can count on reproducing the source you ship
  802. to others.
  803.    One often would like to use `-kv' with `cvs export'.  This causes
  804. any keywords to be expanded such that an import done at some other site
  805. will not lose the keyword revision information.  But be aware that
  806. doesn't handle an export containing binary files correctly.  Also be
  807. aware that after having used `-kv', one can no longer use the `ident'
  808. command (which is part of the RCS suite--see ident(1)) which looks for
  809. keyword strings.  If you want to be able to use `ident' you must not
  810. use `-kv'.
  811. * Menu:
  812. * export options::              export options
  813. File: cvs.info,  Node: export options,  Up: export
  814. export options
  815. --------------
  816.    These standard options are supported by `export' (*note Common
  817. options::., for a complete description of them):
  818. `-D DATE'
  819.      Use the most recent revision no later than DATE.
  820.      If no matching revision is found, retrieve the most recent
  821.      revision (instead of ignoring the file).
  822.      Local; run only in current working directory.
  823.      Do not run any checkout program.
  824.      Export directories recursively.  This is on by default.
  825. `-r TAG'
  826.      Use revision TAG.
  827.    In addition, these options (that are common to `checkout' and
  828. `export') are also supported:
  829. `-d DIR'
  830.      Create a directory called DIR for the working files, instead of
  831.      using the module name.  *Note checkout options::, for complete
  832.      details on how CVS handles this flag.
  833. `-k SUBST'
  834.      Set keyword expansion mode (*note Substitution modes::.).
  835.      Only useful together with `-d DIR'.  *Note checkout options::, for
  836.      complete details on how CVS handles this flag.
  837. File: cvs.info,  Node: history,  Next: import,  Prev: export,  Up: CVS commands
  838. history--Show status of files and users
  839. =======================================
  840.    * Synopsis:     history [-report] [-flags] [-options args] [files...]
  841.    * Requires: the file `$CVSROOT/CVSROOT/history'
  842.    * Changes: nothing.
  843.    CVS can keep a history file that tracks each use of the `checkout',
  844. `commit', `rtag', `update', and `release' commands.  You can use
  845. `history' to display this information in various formats.
  846.    Logging must be enabled by creating the file
  847. `$CVSROOT/CVSROOT/history'.
  848.    *Warning:* `history' uses `-f', `-l', `-n', and `-p' in ways that
  849. conflict with the normal use inside CVS (*note Common options::.).
  850. * Menu:
  851. * history options::             history options
  852. File: cvs.info,  Node: history options,  Up: history
  853. history options
  854. ---------------
  855.    Several options (shown above as `-report')  control  what kind of
  856. report is generated:
  857.      Report on each time commit was used (i.e., each time the
  858.      repository was modified).
  859.      Everything (all record types).  Equivalent to specifying `-x' with
  860.      all record types.  Of course, `-e' will also include record types
  861.      which are added in a future version of CVS; if you are writing a
  862.      script which can only handle certain record types, you'll want to
  863.      specify `-x'.
  864. `-m MODULE'
  865.      Report on a particular module.  (You can meaningfully use `-m'
  866.      more than once on the command line.)
  867.      Report on checked-out modules.
  868.      Report on all tags.
  869. `-x TYPE'
  870.      Extract a particular set of record types TYPE from the CVS
  871.      history.  The types are indicated by single letters, which you may
  872.      specify in combination.
  873.      Certain commands have a single record type:
  874.     `F'
  875.           release
  876.     `O'
  877.           checkout
  878.     `E'
  879.           export
  880.     `T'
  881.           rtag
  882.      One of four record types may result from an update:
  883.     `C'
  884.           A merge was necessary but collisions were detected (requiring
  885.           manual merging).
  886.     `G'
  887.           A merge was necessary and it succeeded.
  888.     `U'
  889.           A working file was copied from the repository.
  890.     `W'
  891.           The working copy of a file was deleted during update (because
  892.           it was gone from the repository).
  893.      One of three record types results from commit:
  894.     `A'
  895.           A file was added for the first time.
  896.     `M'
  897.           A file was modified.
  898.     `R'
  899.           A file was removed.
  900.    The options shown as `-flags' constrain or expand the report without
  901. requiring option arguments:
  902.      Show data for all users (the default is to show data only for the
  903.      user executing `history').
  904.      Show last modification only.
  905.      Show only the records for modifications done from the same working
  906.      directory where `history' is executing.
  907.    The options shown as `-options ARGS' constrain the report based on
  908. an argument:
  909. `-b STR'
  910.      Show data back to a record containing  the  string STR  in  either
  911.      the module name, the file name, or the repository path.
  912. `-D DATE'
  913.      Show data since DATE.  This is slightly different from the normal
  914.      use of `-D DATE', which selects the newest revision older than
  915.      DATE.
  916. `-p REPOSITORY'
  917.      Show data for a particular source repository  (you can specify
  918.      several `-p' options on the same command line).
  919. `-r REV'
  920.      Show records referring to revisions since the revision or tag
  921.      named REV appears in individual RCS files.  Each RCS file is
  922.      searched for the revision or tag.
  923. `-t TAG'
  924.      Show records since tag TAG was last added to the history file.
  925.      This differs from the `-r' flag above in that it reads only the
  926.      history file, not the RCS files, and is much faster.
  927. `-u NAME'
  928.      Show records for user NAME.
  929. File: cvs.info,  Node: import,  Next: log,  Prev: history,  Up: CVS commands
  930. import--Import sources into CVS, using vendor branches
  931. ======================================================
  932.    * Synopsis: import [-options] repository vendortag releasetag...
  933.    * Requires: Repository, source distribution directory.
  934.    * Changes: repository.
  935.    Use `import' to incorporate an entire source distribution from an
  936. outside source (e.g., a source vendor) into your source repository
  937. directory.  You can use this command both for initial creation of a
  938. repository, and for wholesale updates to the module from the outside
  939. source.  *Note Tracking sources::, for a discussion on this subject.
  940.    The REPOSITORY argument gives a directory name (or a path to a
  941. directory) under the CVS root directory for repositories; if the
  942. directory did not exist, import creates it.
  943.    When you use import for updates to source that has been modified in
  944. your source repository (since a prior import), it will notify you of
  945. any files that conflict in the two branches of development; use
  946. `checkout -j' to reconcile the differences, as import instructs you to
  947.    If CVS decides a file should be ignored (*note cvsignore::.), it
  948. does not import it and prints `I ' followed by the filename (*note
  949. import output::., for a complete description of the output).
  950.    If the file `$CVSROOT/CVSROOT/cvswrappers' exists, any file whose
  951. names match the specifications in that file will be treated as packages
  952. and the appropriate filtering will be performed on the file/directory
  953. before being imported.  *Note Wrappers::.
  954.    The outside source is saved in a first-level branch, by default
  955. 1.1.1.  Updates are leaves of this branch; for example, files from the
  956. first imported collection of source will be revision 1.1.1.1, then
  957. files from the first imported update will be revision 1.1.1.2, and so
  958.    At least three arguments are required.  REPOSITORY is needed to
  959. identify the collection of source.  VENDORTAG is a tag for the entire
  960. branch (e.g., for 1.1.1).  You must also specify at least one
  961. RELEASETAG to identify the files at the leaves created each time you
  962. execute `import'.
  963.    Note that `import' does *not* change the directory in which you
  964. invoke it.  In particular, it does not set up that directory as a CVS
  965. working directory; if you want to work with the sources import them
  966. first and then check them out into a different directory (*note Getting
  967. the source::.).
  968. * Menu:
  969. * import options::              import options
  970. * import output::               import output
  971. * import examples::             import examples
  972.